docs: update migration naming conventions to match implementation #953
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Change separator from double underscore (__) to single underscore (_) - Add version pattern specification: ^[vV]?(\d+(\.\d+)*) - Replace suffix-based migration type with comment-based approach - Add MySQL-specific migration type section using -- migration-type: ghost - Remove File Organization and Best Practices sections - Simplify documentation for better readability All changes align with the actual implementation in bytebase/action. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
RainbowDashy
approved these changes
Dec 2, 2025
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the migration file naming conventions in the GitOps workflow documentation to align with the actual Bytebase implementation. The changes transition from double underscore separators and suffix-based migration type detection to single underscore separators and comment-based type specification.
Key changes:
- Changed filename separator from
__(double underscore) to_(single underscore) in all examples - Added explicit regex pattern
^[vV]?(\d+(\.\d+)*)for version format specification - Replaced suffix-based migration type detection (
_dml,_ghost) with comment-based approach (-- migration-type: ghost)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
__) to single underscore (_) in all filename examples^[vV]?(\d+(\.\d+)*)_dml,_ghost) with comment-based approach-- migration-type: ghostsyntaxChanges Made
File Naming Convention
<Version>__<Description>_<Suffix>.sqlto<Version>_<Description>.sqlMigration Type Detection
Removed Sections
All changes align with the actual implementation documented in bytebase/action README.
🤖 Generated with Claude Code